<?php

/**
 * 
 * @copyright (c) 2012 University of Geneva
 * @license GNU General Public License - http://www.gnu.org/copyleft/gpl.html
 * @author Laurent Opprecht laurent@opprecht.info
 */
defined('MOODLE_INTERNAL') || die();

require_once(dirname(__FILE__) . '/restore_emedia_stepslib.php');

/**
 * emedia restore task that provides all the settings and steps to perform one
 * complete restore of the activity
 */
class restore_emedia_activity_task extends restore_activity_task
{

    /**
     * Define (add) particular settings this activity can have
     */
    protected function define_my_settings()
    {
        
    }

    /**
     * Define (add) particular steps this activity can have
     */
    protected function define_my_steps()
    {
        $this->add_step(new restore_emedia_activity_structure_step('emedia_structure', 'emedia.xml'));
    }

    /**
     * Define the contents in the activity that must be
     * processed by the link decoder
     */
    static public function define_decode_contents()
    {
        $contents = array();
        $contents[] = new restore_decode_content('emedia', array('intro'), 'emedia');
        return $contents;
    }

    /**
     * Define the decoding rules for links belonging
     * to the activity to be executed by the link decoder
     */
    static public function define_decode_rules()
    {
        $rules = array();

        $rules[] = new restore_decode_rule('URLINDEX', '/mod/emedia/index.php?id=$1', 'course');
        $rules[] = new restore_decode_rule('URLVIEWBYID', '/mod/emedia/view.php?id=$1', 'course_module');
        $rules[] = new restore_decode_rule('URLVIEWBYU', '/mod/emedia/view.php?u=$1', 'emedia');

        return $rules;
    }

    /**
     * Define the restore log rules that will be applied
     * by the {@link restore_logs_processor} when restoring
     * emedia logs. It must return one array
     * of {@link restore_log_rule} objects
     */
    static public function define_restore_log_rules()
    {
        $rules = array();

        $rules[] = new restore_log_rule('emedia', 'add', 'view.php?id={course_module}', '{emedia}');
        $rules[] = new restore_log_rule('emedia', 'update', 'view.php?id={course_module}', '{emedia}');
        $rules[] = new restore_log_rule('emedia', 'view', 'view.php?id={course_module}', '{emedia}');

        return $rules;
    }

    /**
     * Define the restore log rules that will be applied
     * by the {@link restore_logs_processor} when restoring
     * course logs. It must return one array
     * of {@link restore_log_rule} objects
     *
     * Note this rules are applied when restoring course logs
     * by the restore final task, but are defined here at
     * activity level. All them are rules not linked to any module instance (cmid = 0)
     */
    static public function define_restore_log_rules_for_course()
    {
        $rules = array();

        $rules[] = new restore_log_rule('emedia', 'view all', 'index.php?id={course}', null);

        return $rules;
    }

}
